API for configuring and manipulating DC Motor 31 Click driver. More...

Topics
	DC Motor 31 Registers List
	List of registers of DC Motor 31 Click driver.
	DC Motor 31 Registers Settings
	Settings for registers of DC Motor 31 Click driver.
	DC Motor 31 MikroBUS Map
	MikroBUS pin mapping of DC Motor 31 Click driver.

Functions
void	dcmotor31_cfg_setup (dcmotor31_cfg_t *cfg)
	DC Motor 31 configuration object setup function.
err_t	dcmotor31_init (dcmotor31_t ctx, dcmotor31_cfg_t cfg)
	DC Motor 31 initialization function.
err_t	dcmotor31_default_cfg (dcmotor31_t *ctx)
	DC Motor 31 default configuration function.
err_t	dcmotor31_write_reg (dcmotor31_t *ctx, uint8_t reg, uint8_t data_in)
	DC Motor 31 write reg function.
err_t	dcmotor31_read_reg (dcmotor31_t ctx, uint8_t reg, uint8_t data_out)
	DC Motor 31 read reg function.
void	dcmotor31_enter_sleep (dcmotor31_t *ctx)
	DC Motor 31 enter sleep mode function.
void	dcmotor31_exit_sleep (dcmotor31_t *ctx)
	DC Motor 31 exit sleep mode function.
void	dcmotor31_enable_device (dcmotor31_t *ctx)
	DC Motor 31 enable device function.
void	dcmotor31_disable_device (dcmotor31_t *ctx)
	DC Motor 31 disable device function.
void	dcmotor31_enable_output (dcmotor31_t *ctx)
	DC Motor 31 enable output function.
void	dcmotor31_disable_output (dcmotor31_t *ctx)
	DC Motor 31 disable output function.
void	dcmotor31_set_forward_dir (dcmotor31_t *ctx)
	DC Motor 31 set forward direction function.
void	dcmotor31_set_reverse_dir (dcmotor31_t *ctx)
	DC Motor 31 set reverse direction function.
uint8_t	dcmotor31_get_int_pin (dcmotor31_t *ctx)
	DC Motor 31 get INT pin function.
err_t	dcmotor31_get_lo_pin (dcmotor31_t ctx, uint8_t state)
	DC Motor 31 get LO pin state function.
err_t	dcmotor31_set_torque (dcmotor31_t *ctx, uint8_t torque)
	DC Motor 31 set torque function.
void	dcmotor31_set_mode (dcmotor31_t *ctx, uint8_t mode)
	DC Motor 31 set operation mode function.

Detailed Description

API for configuring and manipulating DC Motor 31 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ dcmotor31_cfg_setup()

void dcmotor31_cfg_setup ( dcmotor31_cfg_t * cfg )

DC Motor 31 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See dcmotor31_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ dcmotor31_default_cfg()

err_t dcmotor31_default_cfg ( dcmotor31_t * ctx )

DC Motor 31 default configuration function.

This function executes a default configuration of DC Motor 31 Click board.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ dcmotor31_disable_device()

void dcmotor31_disable_device ( dcmotor31_t * ctx )

DC Motor 31 disable device function.

This function sets the RST pin to low logic level, disabling the device.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_disable_output()

void dcmotor31_disable_output ( dcmotor31_t * ctx )

DC Motor 31 disable output function.

This function sets the EN pin to low logic level, disabling the motor output.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_enable_device()

void dcmotor31_enable_device ( dcmotor31_t * ctx )

DC Motor 31 enable device function.

This function sets the RST pin to high logic level, enabling the device.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_enable_output()

void dcmotor31_enable_output ( dcmotor31_t * ctx )

DC Motor 31 enable output function.

This function sets the EN pin to high logic level, enabling the motor output.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_enter_sleep()

void dcmotor31_enter_sleep ( dcmotor31_t * ctx )

DC Motor 31 enter sleep mode function.

This function sets the SLEEP pin to low logic level, putting the device into sleep mode.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_exit_sleep()

void dcmotor31_exit_sleep ( dcmotor31_t * ctx )

DC Motor 31 exit sleep mode function.

This function sets the SLEEP pin to high logic level, bringing the device out of sleep mode.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_get_int_pin()

uint8_t dcmotor31_get_int_pin ( dcmotor31_t * ctx )

DC Motor 31 get INT pin function.

This function reads the logic level of the INT pin.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ dcmotor31_get_lo_pin()

err_t dcmotor31_get_lo_pin	(	dcmotor31_t *	ctx,
		uint8_t *	state )

DC Motor 31 get LO pin state function.

This function reads the LO pin state from the INPUT register.

Parameters

[in]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[out]	state	: LO pin logic state.

Returns

0 - Success,
-1 - Error.

Note: None.

◆ dcmotor31_init()

err_t dcmotor31_init	(	dcmotor31_t *	ctx,
		dcmotor31_cfg_t *	cfg )

DC Motor 31 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See dcmotor31_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ dcmotor31_read_reg()

err_t dcmotor31_read_reg	(	dcmotor31_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

DC Motor 31 read reg function.

This function reads data from the selected PCA9538A register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ dcmotor31_set_forward_dir()

void dcmotor31_set_forward_dir ( dcmotor31_t * ctx )

DC Motor 31 set forward direction function.

This function sets the PHA pin to high logic level, configuring the motor to rotate in forward direction.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_set_mode()

void dcmotor31_set_mode	(	dcmotor31_t *	ctx,
		uint8_t	mode )

DC Motor 31 set operation mode function.

This function sets the motor control mode to forward, reverse, or brake.

Parameters

[in]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[in]	mode	: Operation mode (forward, reverse, or brake), see DCMOTOR31_MODE_x macros definition.

Returns: None.

Note: None.

◆ dcmotor31_set_reverse_dir()

void dcmotor31_set_reverse_dir ( dcmotor31_t * ctx )

DC Motor 31 set reverse direction function.

This function sets the PHA pin to low logic level, configuring the motor to rotate in reverse direction.

Parameters

[in] ctx : Click context object. See dcmotor31_t object definition for detailed explanation.

Returns: None.

Note: None.

◆ dcmotor31_set_torque()

err_t dcmotor31_set_torque	(	dcmotor31_t *	ctx,
		uint8_t	torque )

DC Motor 31 set torque function.

This function sets the output torque by writing to the OUTPUT register.

Parameters

[in]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[in]	torque	: Torque level (0-30), see DCMOTOR31_TORQUE_x macros definition.

Returns

0 - Success,
-1 - Error or invalid torque.

Note: None.

◆ dcmotor31_write_reg()

err_t dcmotor31_write_reg	(	dcmotor31_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

DC Motor 31 write reg function.

This function writes a desired data byte to the selected PCA9538A register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See dcmotor31_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ dcmotor31_cfg_setup()

◆ dcmotor31_default_cfg()

◆ dcmotor31_disable_device()

◆ dcmotor31_disable_output()

◆ dcmotor31_enable_device()

◆ dcmotor31_enable_output()

◆ dcmotor31_enter_sleep()

◆ dcmotor31_exit_sleep()

◆ dcmotor31_get_int_pin()

◆ dcmotor31_get_lo_pin()

◆ dcmotor31_init()

◆ dcmotor31_read_reg()

◆ dcmotor31_set_forward_dir()

◆ dcmotor31_set_mode()

◆ dcmotor31_set_reverse_dir()

◆ dcmotor31_set_torque()

◆ dcmotor31_write_reg()